home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dlagtf.z / dlagtf
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  199 lines

  1.  
  2.  
  3.  
  4. DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))                                                          DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DLAGTF - factorize the matrix (T - lambda*I), where T is an n by n
  10.      tridiagonal matrix and lambda is a scalar, as  T - lambda*I = PLU,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DLAGTF( N, A, LAMBDA, B, C, TOL, D, IN, INFO )
  14.  
  15.          INTEGER        INFO, N
  16.  
  17.          DOUBLE         PRECISION LAMBDA, TOL
  18.  
  19.          INTEGER        IN( * )
  20.  
  21.          DOUBLE         PRECISION A( * ), B( * ), C( * ), D( * )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      DLAGTF factorizes the matrix (T - lambda*I), where T is an n by n
  38.      tridiagonal matrix and lambda is a scalar, as T - lambda*I = PLU, where P
  39.      is a permutation matrix, L is a unit lower tridiagonal matrix with at
  40.      most one non-zero sub-diagonal elements per column and U is an upper
  41.      triangular matrix with at most two non-zero super-diagonal elements per
  42.      column.
  43.  
  44.      The factorization is obtained by Gaussian elimination with partial
  45.      pivoting and implicit row scaling.
  46.  
  47.      The parameter LAMBDA is included in the routine so that DLAGTF may be
  48.      used, in conjunction with DLAGTS, to obtain eigenvectors of T by inverse
  49.      iteration.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      N       (input) INTEGER
  54.              The order of the matrix T.
  55.  
  56.      A       (input/output) DOUBLE PRECISION array, dimension (N)
  57.              On entry, A must contain the diagonal elements of T.
  58.  
  59.              On exit, A is overwritten by the n diagonal elements of the upper
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))                                                          DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              triangular matrix U of the factorization of T.
  75.  
  76.      LAMBDA  (input) DOUBLE PRECISION
  77.              On entry, the scalar lambda.
  78.  
  79.      B       (input/output) DOUBLE PRECISION array, dimension (N-1)
  80.              On entry, B must contain the (n-1) super-diagonal elements of T.
  81.  
  82.              On exit, B is overwritten by the (n-1) super-diagonal elements of
  83.              the matrix U of the factorization of T.
  84.  
  85.      C       (input/output) DOUBLE PRECISION array, dimension (N-1)
  86.              On entry, C must contain the (n-1) sub-diagonal elements of T.
  87.  
  88.              On exit, C is overwritten by the (n-1) sub-diagonal elements of
  89.              the matrix L of the factorization of T.
  90.  
  91.      TOL     (input) DOUBLE PRECISION
  92.              On entry, a relative tolerance used to indicate whether or not
  93.              the matrix (T - lambda*I) is nearly singular. TOL should normally
  94.              be chose as approximately the largest relative error in the
  95.              elements of T. For example, if the elements of T are correct to
  96.              about 4 significant figures, then TOL should be set to about
  97.              5*10**(-4). If TOL is supplied as less than eps, where eps is the
  98.              relative machine precision, then the value eps is used in place
  99.              of TOL.
  100.  
  101.      D       (output) DOUBLE PRECISION array, dimension (N-2)
  102.              On exit, D is overwritten by the (n-2) second super-diagonal
  103.              elements of the matrix U of the factorization of T.
  104.  
  105.      IN      (output) INTEGER array, dimension (N)
  106.              On exit, IN contains details of the permutation matrix P. If an
  107.              interchange occurred at the kth step of the elimination, then
  108.              IN(k) = 1, otherwise IN(k) = 0. The element IN(n) returns the
  109.              smallest positive integer j such that
  110.  
  111.              abs( u(j,j) ).le. norm( (T - lambda*I)(j) )*TOL,
  112.  
  113.              where norm( A(j) ) denotes the sum of the absolute values of the
  114.              jth row of the matrix A. If no such j exists then IN(n) is
  115.              returned as zero. If IN(n) is returned as positive, then a
  116.              diagonal element of U is small, indicating that (T - lambda*I) is
  117.              singular or nearly singular,
  118.  
  119.      INFO    (output) INTEGER
  120.              = 0   : successful exit
  121.  
  122. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  123.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))                                                          DDDDLLLLAAAAGGGGTTTTFFFF((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      This man page is available only online.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.